/*
 * Copyright 2010 Biz-e (info@biz-e.nl)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.acl.shared.model;

import javax.persistence.Id;

import nl.biz_e.appengine.lib.shared.objectify.IEntity;

import com.googlecode.objectify.Key;
import com.googlecode.objectify.annotation.Unindexed;

/**
 * Describes a certain authorization context. Might be an application, a part of
 * an application or a group of applications.<br/>
 * The definition of authorization contextx is up to the developer of the system
 * ACL is being used for.
 * 
 * @author Joost A. Bloemsma
 * 
 */
public class Context implements IEntity {
    private static final long serialVersionUID = 1L;
    @Id
    private Long id;
    private String contextId;
    @Unindexed
    private String name;
    @Unindexed
    private String description;
    private Key<Context> parentContext;

    /**
     * @return the contextId
     */
    public String getContextId() {
        return contextId;
    }

    /**
     * @param contextId
     *            the contextId to set
     */
    public void setContextId(String contextId) {
        this.contextId = contextId;
    }

    /**
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * @param name
     *            the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @param description
     *            the description to set
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * @return the parentContext
     */
    public Key<Context> getParentContext() {
        return parentContext;
    }

    /**
     * @param parentContext
     *            the parentContext to set
     */
    public void setParentContext(Key<Context> parentContext) {
        this.parentContext = parentContext;
    }

    /**
     * @return the id
     */
    public Long getId() {
        return id;
    }

    /**
     * @return {@code true} if this context has no parents
     */
    public boolean isRootContext() {
        return (parentContext == null);
    }
}
